/*
 * Copyright (c) 2009 DeledImporter
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Pyro Games' nor the names of its contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package net.pyrogames.deled.importer;

import org.w3c.dom.Element;

import net.pyrogames.deled.geometry.DXSNode;

/**
 * Extensions to the <code>DXSImporter</code> implements
 * this interface. All extensions should take in a <code>{@link DXSNode}</code>
 * and an element from the dxs XML file. This allows a user
 * to specify a custom element in DeleD and attach it to
 * the internal representation of the scene in the importer.
 * 
 * @author Nicholas Woodfield
 *
 */
public interface DXSExtension {

	/**
	 * Executes the extension and returns if it was successful or not.
	 * 
	 * @param node
	 * 		  <code>DXSNode</code> that is the root of the scene or another
	 * 		part of the scene graph.
	 * @param dxsElem
	 * 		  <code>Element</code> that is the representation of a scene
	 * 		element (usually geometry) in the dxs XML file.
	 * @return true if the operation was a success, false otherwise
	 */
	public boolean executeExtension(DXSNode root, Element dxsElem);
}
